Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Video consent required parameters #71

Merged
merged 6 commits into from
Oct 22, 2024
Merged

Conversation

becky-gilbert
Copy link
Contributor

@becky-gilbert becky-gilbert commented Oct 18, 2024

This PR attempts to clarify the required vs optional parameters for the video-consent plugin.

In the plugin's parameters object, I changed the default values to undefined for any required parameters. This way, jsPsych will throw an error when the experiment first loads if any required parameters are missing.

For each parameter in the documentation, I added the default value, if it exists, or undefined if there's no default (i.e. required).

Copy link

changeset-bot bot commented Oct 18, 2024

⚠️ No Changeset found

Latest commit: 2e35efa

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@becky-gilbert becky-gilbert requested a review from okaycj October 21, 2024 18:05
@becky-gilbert becky-gilbert self-assigned this Oct 21, 2024
Copy link
Contributor Author

@becky-gilbert becky-gilbert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

GH says I'm not allowed to approve my own pull request 🙄 But I approve!

The required/optional subsections are very helpful - thank you!

packages/surveys/README.md Show resolved Hide resolved
@okaycj okaycj force-pushed the video-consent-required-params branch from 6046548 to e34cd6c Compare October 22, 2024 18:26
@okaycj okaycj merged commit 6c17133 into main Oct 22, 2024
2 checks passed
@okaycj okaycj deleted the video-consent-required-params branch October 22, 2024 18:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants